home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / cheevx.z / cheevx
Encoding:
Text File  |  2002-10-03  |  8.6 KB  |  265 lines
  1.  
  2.  
  3.  
  4. CCCCHHHHEEEEEEEEVVVVXXXX((((3333SSSS))))                                                          CCCCHHHHEEEEEEEEVVVVXXXX((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CHEEVX - compute selected eigenvalues and, optionally, eigenvectors of a
  10.      complex Hermitian matrix A
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CHEEVX( JOBZ, RANGE, UPLO, N, A, LDA, VL, VU, IL, IU, ABSTOL,
  14.                         M, W, Z, LDZ, WORK, LWORK, RWORK, IWORK, IFAIL, INFO )
  15.  
  16.          CHARACTER      JOBZ, RANGE, UPLO
  17.  
  18.          INTEGER        IL, INFO, IU, LDA, LDZ, LWORK, M, N
  19.  
  20.          REAL           ABSTOL, VL, VU
  21.  
  22.          INTEGER        IFAIL( * ), IWORK( * )
  23.  
  24.          REAL           RWORK( * ), W( * )
  25.  
  26.          COMPLEX        A( LDA, * ), WORK( * ), Z( LDZ, * )
  27.  
  28. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  29.      These routines are part of the SCSL Scientific Library and can be loaded
  30.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  31.      directs the linker to use the multi-processor version of the library.
  32.  
  33.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  34.      4 bytes (32 bits). Another version of SCSL is available in which integers
  35.      are 8 bytes (64 bits).  This version allows the user access to larger
  36.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  37.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  38.      only one of the two versions; 4-byte integer and 8-byte integer library
  39.      calls cannot be mixed.
  40.  
  41. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  42.      CHEEVX computes selected eigenvalues and, optionally, eigenvectors of a
  43.      complex Hermitian matrix A. Eigenvalues and eigenvectors can be selected
  44.      by specifying either a range of values or a range of indices for the
  45.      desired eigenvalues.
  46.  
  47.  
  48. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  49.      JOBZ    (input) CHARACTER*1
  50.              = 'N':  Compute eigenvalues only;
  51.              = 'V':  Compute eigenvalues and eigenvectors.
  52.  
  53.      RANGE   (input) CHARACTER*1
  54.              = 'A': all eigenvalues will be found.
  55.              = 'V': all eigenvalues in the half-open interval (VL,VU] will be
  56.              found.  = 'I': the IL-th through IU-th eigenvalues will be found.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCHHHHEEEEEEEEVVVVXXXX((((3333SSSS))))                                                          CCCCHHHHEEEEEEEEVVVVXXXX((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      UPLO    (input) CHARACTER*1
  75.              = 'U':  Upper triangle of A is stored;
  76.              = 'L':  Lower triangle of A is stored.
  77.  
  78.      N       (input) INTEGER
  79.              The order of the matrix A.  N >= 0.
  80.  
  81.      A       (input/output) COMPLEX array, dimension (LDA, N)
  82.              On entry, the Hermitian matrix A.  If UPLO = 'U', the leading N-
  83.              by-N upper triangular part of A contains the upper triangular
  84.              part of the matrix A.  If UPLO = 'L', the leading N-by-N lower
  85.              triangular part of A contains the lower triangular part of the
  86.              matrix A.  On exit, the lower triangle (if UPLO='L') or the upper
  87.              triangle (if UPLO='U') of A, including the diagonal, is
  88.              destroyed.
  89.  
  90.      LDA     (input) INTEGER
  91.              The leading dimension of the array A.  LDA >= max(1,N).
  92.  
  93.      VL      (input) REAL
  94.              VU      (input) REAL If RANGE='V', the lower and upper bounds of
  95.              the interval to be searched for eigenvalues. VL < VU.  Not
  96.              referenced if RANGE = 'A' or 'I'.
  97.  
  98.      IL      (input) INTEGER
  99.              IU      (input) INTEGER If RANGE='I', the indices (in ascending
  100.              order) of the smallest and largest eigenvalues to be returned.  1
  101.              <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.  Not
  102.              referenced if RANGE = 'A' or 'V'.
  103.  
  104.      ABSTOL  (input) REAL
  105.              The absolute error tolerance for the eigenvalues.  An approximate
  106.              eigenvalue is accepted as converged when it is determined to lie
  107.              in an interval [a,b] of width less than or equal to
  108.  
  109.              ABSTOL + EPS *   max( |a|,|b| ) ,
  110.  
  111.              where EPS is the machine precision.  If ABSTOL is less than or
  112.              equal to zero, then  EPS*|T|  will be used in its place, where
  113.              |T| is the 1-norm of the tridiagonal matrix obtained by reducing
  114.              A to tridiagonal form.
  115.  
  116.              Eigenvalues will be computed most accurately when ABSTOL is set
  117.              to twice the underflow threshold 2*SLAMCH('S'), not zero.  If
  118.              this routine returns with INFO>0, indicating that some
  119.              eigenvectors did not converge, try setting ABSTOL to
  120.              2*SLAMCH('S').
  121.  
  122.              See "Computing Small Singular Values of Bidiagonal Matrices with
  123.              Guaranteed High Relative Accuracy," by Demmel and Kahan, LAPACK
  124.              Working Note #3.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCHHHHEEEEEEEEVVVVXXXX((((3333SSSS))))                                                          CCCCHHHHEEEEEEEEVVVVXXXX((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      M       (output) INTEGER
  141.              The total number of eigenvalues found.  0 <= M <= N.  If RANGE =
  142.              'A', M = N, and if RANGE = 'I', M = IU-IL+1.
  143.  
  144.      W       (output) REAL array, dimension (N)
  145.              On normal exit, the first M elements contain the selected
  146.              eigenvalues in ascending order.
  147.  
  148.      Z       (output) COMPLEX array, dimension (LDZ, max(1,M))
  149.              If JOBZ = 'V', then if INFO = 0, the first M columns of Z contain
  150.              the orthonormal eigenvectors of the matrix A corresponding to the
  151.              selected eigenvalues, with the i-th column of Z holding the
  152.              eigenvector associated with W(i).  If an eigenvector fails to
  153.              converge, then that column of Z contains the latest approximation
  154.              to the eigenvector, and the index of the eigenvector is returned
  155.              in IFAIL.  If JOBZ = 'N', then Z is not referenced.  Note: the
  156.              user must ensure that at least max(1,M) columns are supplied in
  157.              the array Z; if RANGE = 'V', the exact value of M is not known in
  158.              advance and an upper bound must be used.
  159.  
  160.      LDZ     (input) INTEGER
  161.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  162.              'V', LDZ >= max(1,N).
  163.  
  164.      WORK    (workspace/output) COMPLEX array, dimension (LWORK)
  165.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  166.  
  167.      LWORK   (input) INTEGER
  168.              The length of the array WORK.  LWORK >= max(1,2*N-1).  For
  169.              optimal efficiency, LWORK >= (NB+1)*N, where NB is the max of the
  170.              blocksize for CHETRD and for CUNMTR as returned by ILAENV.
  171.  
  172.              If LWORK = -1, then a workspace query is assumed; the routine
  173.              only calculates the optimal size of the WORK array, returns this
  174.              value as the first entry of the WORK array, and no error message
  175.              related to LWORK is issued by XERBLA.
  176.  
  177.      RWORK   (workspace) REAL array, dimension (7*N)
  178.  
  179.      IWORK   (workspace) INTEGER array, dimension (5*N)
  180.  
  181.      IFAIL   (output) INTEGER array, dimension (N)
  182.              If JOBZ = 'V', then if INFO = 0, the first M elements of IFAIL
  183.              are zero.  If INFO > 0, then IFAIL contains the indices of the
  184.              eigenvectors that failed to converge.  If JOBZ = 'N', then IFAIL
  185.              is not referenced.
  186.  
  187.      INFO    (output) INTEGER
  188.              = 0:  successful exit
  189.              < 0:  if INFO = -i, the i-th argument had an illegal value
  190.              > 0:  if INFO = i, then i eigenvectors failed to converge.  Their
  191.              indices are stored in array IFAIL.
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. CCCCHHHHEEEEEEEEVVVVXXXX((((3333SSSS))))                                                          CCCCHHHHEEEEEEEEVVVVXXXX((((3333SSSS))))
  203.  
  204.  
  205.  
  206. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  207.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  208.  
  209.      This man page is available only online.
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.